/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      AOTLemmatizerInterface.hpp
 *
 * $FTS$
 */
#ifndef _AOT_LEMMATIZER_INTERFACE_HPP__
#define _AOT_LEMMATIZER_INTERFACE_HPP__ 1

#define C_RUS_GRAM_TAB 0x00000001
#define C_GER_GRAM_TAB 0x00000002
#define C_ENG_GRAM_TAB 0x00000004

/**
  @file AOTLemmatizerInterface.hpp
  @brief AOT's Lemmatizer interface (http://www.aot.ru/)
*/

#include <LemmatizerInterface.hpp>

// FWD Declarations
namespace lem
{
	class Lemmatizer;
}

namespace FTSS // FullTextSearchSystem
{

/**
  @class AOTLemmatizerInterface AOTLemmatizerInterface.hpp <AOTLemmatizerInterface.hpp>
  @brief Get first forms of word
*/
class AOTLemmatizerInterface:
  public LemmatizerInterface
{
public:
	/**
	  @brief Consrtructor
	  @param sRML - directory with lemmatizer database
	  @param iLanguages - languages to load
	*/
	AOTLemmatizerInterface(CCHAR_P sRML, const INT_32 & iLanguages);

	/**
	  @brief A destructor
	*/
	~AOTLemmatizerInterface() throw();

private:
	lem::Lemmatizer  * pLemmatizer;
	/**
	  @brief Check word
	  @param sWord - word
	  @param iWordLength - length of word
	  @return 0 if this lemmatizer can handler this word, -1 - if not
	*/
	INT_32 CanLemmatize(CCHAR_P sWord, const UINT_32 & iWordLength);

	/**
	  @brief Get all firts forms of the word
	  @param sWord - word
	  @param iWordLength - length of word
	  @param iUseParadigms - use paradigms to predict word form of unknown words or not
	  @return vector with all first forms of the word
	*/
	STLW::vector<STLW::string> FirstForms(CCHAR_P sWord, const UINT_32 & iWordLength, const UINT_32 & iUseParadigms);
};

} // namespace FTSS
#endif // _AOT_LEMMATIZER_INTERFACE_HPP__
// End.
